<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>FoX</title>
  <link rel="stylesheet" type="text/css" href="DoX.css"/>
</head>
<body>
  <div class="DoX">
<h1>FoX documentation.</h1>

<p><a href="FoX_DoX.html">All in one page</a></p>

<p><a href="FoX.html">Separate pages</a></p>

<h2>Introduction</h2>

<p>This document is the primary documentation for FoX, the Fortan/XML library. See below for <a href="#otherdoc">other sources of documentation</a>. It consists of:</p>

<p>Reference information on <a href="Versioning.html">versions</a>, 
<a href="Standards.html">standards compliance</a>,
and <a href="Licensing.html">licensing</a>.</p>

<p>Information about how to <a href="Compilation.html">get up and running with FoX</a>
and how to <a href="Embedding.html">use FoX in an existing project</a>.</p>

<p>Finally, there is <a href="#apidoc">full API reference documentation</a>.</p>

<h2>Other documentation</h2>

<p><a name="otherdoc"/></p>

<p>This documentation is largely reference in nature. For new users it is best to start elsewhere:</p>

<h3>iFaX workshops</h3>

<p>Two workshops, entitled iFaX (Integrating Fortran and XML) have been run teaching the use of FoX, <a href="http://www.niees.ac.uk/events/ifax/index.shtml">one in January 2007</a>, and <a href="http://www.nesc.ac.uk/esi/events/841/">one in January 2008</a>. The full documentation and lectures from these may be found at:</p>

<ul>
<li><a href="http://buffalo.niees.group.cam.ac.uk/archive2.php?event_details=ifax">iFaX I</a></li>
<li><a href="http://www.nesc.ac.uk/action/esi/contribution.cfm?Title=841">iFaX II</a></li>
</ul>

<h3>Tutorials</h3>

<p>Out of the above workshops, some <a href="http://www1.gly.bris.ac.uk/~walker/FoX/iFaX">tutorial material</a> has been written, focussing on different use cases. Currently two are available:</p>

<ul>
<li><a href="http://www1.gly.bris.ac.uk/~walker/FoX/iFaX/iFaX.4/iFaX.4.html">SAX input</a></li>
<li><a href="http://www1.gly.bris.ac.uk/~walker/FoX/iFaX/iFaX.5/iFaX.5.html">DOM input</a></li>
</ul>

<p>There is also tutorial information on the use of WKML <a href="http://web.me.com/dove_family/xml/kml.html">here</a>.</p>

<h2>API documentation</h2>

<p><a name="apidoc"/></p>

<ul>
<li>FoX has seven sets of publically exported interfaces. These are documented here:</li>
</ul>

<h3>COMMON interfaces</h3>

<ul>
<li><a href="FoX_common.html">FoX_common</a></li>
<li><a href="FoX_utils.html">FoX_utils</a></li>
</ul>

<h3>OUTPUT interfaces</h3>

<ul>
<li><a href="FoX_wxml.html">FoX_wxml</a></li>
<li><a href="FoX_wcml.html">FoX_wcml</a></li>
<li><a href="FoX_wkml.html">FoX_wkml</a></li>
</ul>

<h3>INPUT interface</h3>

<ul>
<li><a href="FoX_sax.html">FoX_sax</a></li>
<li><a href="FoX_dom.html">FoX_dom</a></li>
</ul>

<p>These documents describe all publically usable APIs.</p>

<p>Worked examples of the use of some of these APIs may be found in the <code>examples/</code> subdirectory, and tutorial-style documentaion is available from the links <a href="#otherdoc">above</a>.</p>

<h2>Other things</h2>

<ul>
<li><p><a href="Debugging.html">Hints for debugging</a></p></li>
<li><p><a href="Information.html">Further information</a></p></li>
</ul>
</div>
</body>
</html>
